Sphinx and its depends have have been updated to more recent versions. For Sphinx this brings a number of improvements, and brings it from v5.3 to v8.1.

It should be noted that this will require python 3.11 or greater. Running linkcheck locally resulted in a number of ssl cert errors. These errors are a new feature. However it does not appear as if it can be disabled. It is also possible that the errors resulted from a local issue.

QA Steps: Ran linkcheck (see above note), checked rendered HTML, checked that PDF built as expected

No related tasks/issues, regular maintenance task

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

• Merge (pending reviews)

Overview

Sphinx 5 -> 8. A large number of changes and fixes have been introduced.

The required Python version has changed from 3.9 to 3.11

Addressed some of the linkcheck issues found.

It is possible that there will be CI build issues to work out.

Checklist

• Avoid changing any header associated with a link/reference.
• Run make linkcheck.
• View HTML in a browser to check rendering.
• follow best practices for commits.
  • Descriptive title written in the imperative.
  • Include brief overview of QA steps taken.
  • Mention any related issues numbers.
  • End message with sign off/DCO line (-s, --signoff).
  • Sign commit with your gpg key (-S, --gpg-sign).
  • Squash commits if needed.
• Request PR review by a technical writer and at least one peer.